Перейти к основному содержимому

API

Сервис сравнения документов предоставляет REST API для загрузки документов и запуска процесса их сравнения. Получение результатов сравнения по API на данный момент недоступено. Результатом процесса сравнения является уникальная ссылка для просмотра расхождений между документами

Авторизация​

Все запросы к API должны иметь заголовок "Authorization" со значением "Bearer token", где token = ваш токен для доступа к API.

Для получения токена необходимо обратиться к техподдержку: в Telegram или по почте

Сценарий работы​

Загрузка файлов​

Пример запроса:

Url: https://comparer.correct.su/api/Task/upload
Headers: Authorization
Method: POST
Body: binary

Содержимое файла должно быть передано в теле запроса в виде бинарных данных. Поддерживаются файлы форматов PDF, JPG/JPEG, XLSX, DOCX.

Пример ответа:

{
  "status": "success",
  "documentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6"
}

Запуск сравнения​

Url: https://comparer.correct.su/Comparator/api/Task/create
Headers: Authorization
Method: POST
Body: 
{
  "documents": [
    {
      "documentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
      "fileName": "Исходный документ.pdf",
      "isEtalon": true
    },
    {
      "documentId": "dd2e9e1a-06f8-4d92-a282-ab4eeefef163",
      "fileName": "Измененный документ.pdf",
      "isEtalon": false
    }
  ],
  "callbackUrl": "https://your.custom.api/for/callback"
}

Пример ответа:

{
  "taskId": "df3f24fccwhuis98snDUA9S08AAasidoia2409"
}

В теле запроса необходимо передать массив documents, с идентификаторами документов, полученными на предыдущем шаге.

При вызове данного метода необходимо соблюсти ряд условий:

  • Массив "documents" должен состоять из двух элементов
  • Один из элементов массива должен содержать поле "isEtalon" со значением true, а другой – со значением false
  • Значения полей "fileName" не должны совпадать

Поле "callbackUrl" является опциональным. Если оно было передано, по завершению обработки будет совершен POST-вызов метода по переданному адреса.

Пример callback'а:

{
  "taskId" "df3f24fccwhuis98snDUA9S08AAasidoia2409"
  "status": "success"
}

Значение поля "taskId" будет такое же, как в ответе на запрос "/Comparator/api/Task/create"

Просмотр результатов​

Идентификатор задачи, полученных на прошлом этапе необходимо подставить в ссылку https://doccomparer.correct.su/docs/{key}, вместо {key}. Таким образом, вы получите ссылку вида: https://doccomparer.correct.su/docs/df3f24fccwhuis98snDUA9S08AAasidoia2409

Пользователь, переходящий по ссылке должен быть авторизован в личном кабинете и иметь роль "Сравнение документов" или "Администратор"